Update Recipient
Modifies demographic information for an existing insurance recipient. This approach uses an operation rather than a RESTful PUT for two reasons:
- Business rules require capturing a 'comment' observation if changes are made to the recipient's address, and
- updates can be 'inserted' in the historical record, which standard FHIR REST does not support. Updates include an 'effective date', meaning that historical records can also be injected. If a record is being injected prior to the earliest effective date, the data (other than effective date) must be unchanged from the earliest effective record.
Mechanism
POST [base]/Patient/[ODBNumber]/$updateRecipient
| Payload | Example |
|---|---|
| In: Patient Update parameters | Patient update example |
| Out (success): HTTP 200 with Location header set to ODBNumber for updated record and version timestamp, Warning Operation Outcome (optional) | |
| Out (error): HTTP 4xx or 5xx Operation Outcome (optional) |